docs: add user guide with screenshots - #131
Merged
Merged
Conversation
Adds comprehensive documentation covering McpMux concepts (Spaces, FeatureSets, Clients, Gateway, Security), getting started guide, server management, and server definition schema reference. Content is sourced by mcpmux.discover.ui at build time via fetch-docs.mjs and rendered with Fumadocs on mcpmux.com/docs. Includes GitHub Action to trigger Cloudflare Pages rebuild when docs change on main. Signed-off-by: Mohammod Al Amin Ashik <maa.ashik00@gmail.com>
its-mash
force-pushed
the
docs/add-user-guide
branch
from
February 20, 2026 08:57
4a33529 to
0ebcab5
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
https://mcpmux.com/screenshots/) so they render on both GitHub and the websitemeta.jsonwith Getting Started / Core Concepts / Advanced sectionsdocs-deploy.yml) to trigger Cloudflare Pages rebuild whendocs/guide/**changes on mainHow it works
The MDX source files live here in the public
mcp-muxrepo. At build time,mcpmux.discover.uirunsfetch-docs.mjswhich copies these files into itscontent/docs/directory. Fumadocs renders them atmcpmux.com/docs/.Companion PR
New files
docs/guide/*.mdx— 9 documentation pages +meta.jsonsidebar config.github/workflows/docs-deploy.yml— auto-triggers website rebuild on docs changesTest plan
pnpm buildpasses inmcpmux.discover.uiwith all 55 static pages generated